<?xml version="1.0" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>PlPN::ScriptRegistry - The script registry object</title>
<link rel="stylesheet" href="../PlPN.css" type="text/css" />
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
<link rev="made" href="mailto:" />
</head>

<body>


<!-- INDEX BEGIN -->
<div name="index">
<p><a name="__index__"></a></p>

<ul>

	<li><a href="#name">NAME</a></li>
	<li><a href="#synopsis">SYNOPSIS</a></li>
	<li><a href="#description">DESCRIPTION</a></li>
	<li><a href="#methods">METHODS</a></li>
	<li><a href="#copyright_and_licence">COPYRIGHT and LICENCE</a></li>
</ul>

<hr name="index" />
</div>
<!-- INDEX END -->

<p>
</p>
<h1><a name="name">NAME</a></h1>
<p>PlPN::ScriptRegistry - The script registry object</p>
<p>
</p>
<hr />
<h1><a name="synopsis">SYNOPSIS</a></h1>
<pre>
        use PlPN qw(PN);
        
        my $reg = PN-&gt;GetScriptRegistry;
        $reg-&gt;RegisterRunner($some_id, $some_runner);
        
        # etc.</pre>
<p>
</p>
<hr />
<h1><a name="description">DESCRIPTION</a></h1>
<p>Allows access to the Programmer's Notepad script registry from Perl.</p>
<p>This object is not very useful unless you plan to write your own
script runner.</p>
<p>
</p>
<hr />
<h1><a name="methods">METHODS</a></h1>
<dl>
<dt><strong><a name="add" class="item">Add($group, $name, $scriptref)</a></strong></dt>

<dd>
<p>Adds a script to the registry. <code>$name</code> will appear under <code>$group</code> in the
Scripts window; these should be user-friendly strings. <code>$scriptref</code>
is a string in the form <code>runnerID:scriptID</code>. See the
<a href="./ScriptRunner.html">PlPN::ScriptRunner</a> synopsis for a somewhat contrived
example.</p>
</dd>
<dt><strong><a name="registerrunner" class="item">RegisterRunner($id, $runner)</a></strong></dt>

<dd>
<p>Registers <code>$runner</code> (a ScriptRunner object) under the <code>$id</code> (a string).</p>
</dd>
<dt><strong><a name="removerunner" class="item">RemoveRunner($id)</a></strong></dt>

<dd>
<p>Removes the ScriptRunner object registered under <code>$id</code>.</p>
</dd>
<dt><strong><a name="getrunner" class="item">GetRunner($id)</a></strong></dt>

<dd>
<p>Returns the ScriptRunner object registered under <code>$id</code>.</p>
</dd>
<dt><strong><a name="enableschemescripts" class="item">EnableSchemeScripts($scheme, $id)</a></strong></dt>

<dd>
<p>Allows documents with the given scheme to be added to the Scripts window via
the context menu. They will appear in the Scripts window under the group
'User Scripts' with the filename from the tab as the script name.</p>
</dd>
</dl>
<p>
</p>
<hr />
<h1><a name="copyright_and_licence">COPYRIGHT and LICENCE</a></h1>
<p>Copyright (c) 2012 Sean Healy. All rights reserved.</p>
<p>This program is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.</p>

</body>

</html>
